Autogenerated HTML docs for v1.8.1-rc2-5-g252f9
diff --git a/git-format-patch.html b/git-format-patch.html index 60107a5..dbb219e 100644 --- a/git-format-patch.html +++ b/git-format-patch.html
@@ -2,15 +2,25 @@ "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd"> <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en"> <head> -<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> -<meta name="generator" content="AsciiDoc 8.5.2" /> +<meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" /> +<meta name="generator" content="AsciiDoc 8.6.8" /> <title>git-format-patch(1)</title> <style type="text/css"> -/* Debug borders */ -p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 { -/* - border: 1px solid red; -*/ +/* Shared CSS for AsciiDoc xhtml11 and html5 backends */ + +/* Default font. */ +body { + font-family: Georgia,serif; +} + +/* Title font. */ +h1, h2, h3, h4, h5, h6, +div.title, caption.title, +thead, p.table.header, +#toctitle, +#author, #revnumber, #revdate, #revremark, +#footer { + font-family: Arial,Helvetica,sans-serif; } body { @@ -35,13 +45,8 @@ color: #083194; } -tt { - color: navy; -} - h1, h2, h3, h4, h5, h6 { color: #527bbd; - font-family: sans-serif; margin-top: 1.2em; margin-bottom: 0.5em; line-height: 1.3; @@ -59,9 +64,11 @@ h3 + * { clear: left; } +h5 { + font-size: 1.0em; +} div.sectionbody { - font-family: serif; margin-left: 0; } @@ -77,45 +84,48 @@ ul, ol, li > p { margin-top: 0; } +ul > li { color: #aaa; } +ul > li > * { color: black; } -pre { +.monospaced, code, pre { + font-family: "Courier New", Courier, monospace; + font-size: inherit; + color: navy; padding: 0; margin: 0; } -span#author { + +#author { color: #527bbd; - font-family: sans-serif; font-weight: bold; font-size: 1.1em; } -span#email { +#email { } -span#revnumber, span#revdate, span#revremark { - font-family: sans-serif; +#revnumber, #revdate, #revremark { } -div#footer { - font-family: sans-serif; +#footer { font-size: small; border-top: 2px solid silver; padding-top: 0.5em; margin-top: 4.0em; } -div#footer-text { +#footer-text { float: left; padding-bottom: 0.5em; } -div#footer-badges { +#footer-badges { float: right; padding-bottom: 0.5em; } -div#preamble { +#preamble { margin-top: 1.5em; margin-bottom: 1.5em; } -div.tableblock, div.imageblock, div.exampleblock, div.verseblock, +div.imageblock, div.exampleblock, div.verseblock, div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock, div.admonitionblock { margin-top: 1.0em; @@ -135,7 +145,6 @@ /* Block element titles. */ div.title, caption.title { color: #527bbd; - font-family: sans-serif; font-weight: bold; text-align: left; margin-top: 1.0em; @@ -157,13 +166,15 @@ div.sidebarblock > div.content { background: #ffffee; - border: 1px solid silver; + border: 1px solid #dddddd; + border-left: 4px solid #f0f0f0; padding: 0.5em; } div.listingblock > div.content { - border: 1px solid silver; - background: #f4f4f4; + border: 1px solid #dddddd; + border-left: 5px solid #f0f0f0; + background: #f8f8f8; padding: 0.5em; } @@ -171,8 +182,8 @@ padding-left: 1.0em; margin-left: 1.0em; margin-right: 10%; - border-left: 5px solid #dddddd; - color: #777777; + border-left: 5px solid #f0f0f0; + color: #888; } div.quoteblock > div.attribution { @@ -180,8 +191,9 @@ text-align: right; } -div.verseblock > div.content { - white-space: pre; +div.verseblock > pre.content { + font-family: inherit; + font-size: inherit; } div.verseblock > div.attribution { padding-top: 0.75em; @@ -254,35 +266,12 @@ margin-bottom: 0.1em; } -div.tableblock > table { - border: 3px solid #527bbd; -} -thead, p.table.header { - font-family: sans-serif; - font-weight: bold; -} tfoot { font-weight: bold; } td > div.verse { white-space: pre; } -p.table { - margin-top: 0; -} -/* Because the table frame attribute is overriden by CSS in most browsers. */ -div.tableblock > table[frame="void"] { - border-style: none; -} -div.tableblock > table[frame="hsides"] { - border-left-style: none; - border-right-style: none; -} -div.tableblock > table[frame="vsides"] { - border-top-style: none; - border-bottom-style: none; -} - div.hdlist { margin-top: 0.8em; @@ -339,25 +328,32 @@ min-width: 100px; } - -@media print { - div#footer-badges { display: none; } +div.colist td { + padding-right: 0.5em; + padding-bottom: 0.3em; + vertical-align: top; +} +div.colist td img { + margin-top: 0.3em; } -div#toc { +@media print { + #footer-badges { display: none; } +} + +#toc { margin-bottom: 2.5em; } -div#toctitle { +#toctitle { color: #527bbd; - font-family: sans-serif; font-size: 1.1em; font-weight: bold; margin-top: 1.0em; margin-bottom: 0.1em; } -div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 { +div.toclevel0, div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 { margin-top: 0; margin-bottom: 0; } @@ -373,69 +369,173 @@ margin-left: 6em; font-size: 0.9em; } -/* Overrides for manpage documents */ -h1 { + +span.aqua { color: aqua; } +span.black { color: black; } +span.blue { color: blue; } +span.fuchsia { color: fuchsia; } +span.gray { color: gray; } +span.green { color: green; } +span.lime { color: lime; } +span.maroon { color: maroon; } +span.navy { color: navy; } +span.olive { color: olive; } +span.purple { color: purple; } +span.red { color: red; } +span.silver { color: silver; } +span.teal { color: teal; } +span.white { color: white; } +span.yellow { color: yellow; } + +span.aqua-background { background: aqua; } +span.black-background { background: black; } +span.blue-background { background: blue; } +span.fuchsia-background { background: fuchsia; } +span.gray-background { background: gray; } +span.green-background { background: green; } +span.lime-background { background: lime; } +span.maroon-background { background: maroon; } +span.navy-background { background: navy; } +span.olive-background { background: olive; } +span.purple-background { background: purple; } +span.red-background { background: red; } +span.silver-background { background: silver; } +span.teal-background { background: teal; } +span.white-background { background: white; } +span.yellow-background { background: yellow; } + +span.big { font-size: 2em; } +span.small { font-size: 0.6em; } + +span.underline { text-decoration: underline; } +span.overline { text-decoration: overline; } +span.line-through { text-decoration: line-through; } + +div.unbreakable { page-break-inside: avoid; } + + +/* + * xhtml11 specific + * + * */ + +div.tableblock { + margin-top: 1.0em; + margin-bottom: 1.5em; +} +div.tableblock > table { + border: 3px solid #527bbd; +} +thead, p.table.header { + font-weight: bold; + color: #527bbd; +} +p.table { + margin-top: 0; +} +/* Because the table frame attribute is overriden by CSS in most browsers. */ +div.tableblock > table[frame="void"] { + border-style: none; +} +div.tableblock > table[frame="hsides"] { + border-left-style: none; + border-right-style: none; +} +div.tableblock > table[frame="vsides"] { + border-top-style: none; + border-bottom-style: none; +} + + +/* + * html5 specific + * + * */ + +table.tableblock { + margin-top: 1.0em; + margin-bottom: 1.5em; +} +thead, p.tableblock.header { + font-weight: bold; + color: #527bbd; +} +p.tableblock { + margin-top: 0; +} +table.tableblock { + border-width: 3px; + border-spacing: 0px; + border-style: solid; + border-color: #527bbd; + border-collapse: collapse; +} +th.tableblock, td.tableblock { + border-width: 1px; + padding: 4px; + border-style: solid; + border-color: #527bbd; +} + +table.tableblock.frame-topbot { + border-left-style: hidden; + border-right-style: hidden; +} +table.tableblock.frame-sides { + border-top-style: hidden; + border-bottom-style: hidden; +} +table.tableblock.frame-none { + border-style: hidden; +} + +th.tableblock.halign-left, td.tableblock.halign-left { + text-align: left; +} +th.tableblock.halign-center, td.tableblock.halign-center { + text-align: center; +} +th.tableblock.halign-right, td.tableblock.halign-right { + text-align: right; +} + +th.tableblock.valign-top, td.tableblock.valign-top { + vertical-align: top; +} +th.tableblock.valign-middle, td.tableblock.valign-middle { + vertical-align: middle; +} +th.tableblock.valign-bottom, td.tableblock.valign-bottom { + vertical-align: bottom; +} + + +/* + * manpage specific + * + * */ + +body.manpage h1 { padding-top: 0.5em; padding-bottom: 0.5em; border-top: 2px solid silver; border-bottom: 2px solid silver; } -h2 { +body.manpage h2 { border-style: none; } -div.sectionbody { - margin-left: 5%; +body.manpage div.sectionbody { + margin-left: 3em; } @media print { - div#toc { display: none; } + body.manpage div#toc { display: none; } } -/* Workarounds for IE6's broken and incomplete CSS2. */ -div.sidebar-content { - background: #ffffee; - border: 1px solid silver; - padding: 0.5em; -} -div.sidebar-title, div.image-title { - color: #527bbd; - font-family: sans-serif; - font-weight: bold; - margin-top: 0.0em; - margin-bottom: 0.5em; -} - -div.listingblock div.content { - border: 1px solid silver; - background: #f4f4f4; - padding: 0.5em; -} - -div.quoteblock-attribution { - padding-top: 0.5em; - text-align: right; -} - -div.verseblock-content { - white-space: pre; -} -div.verseblock-attribution { - padding-top: 0.75em; - text-align: left; -} - -div.exampleblock-content { - border-left: 3px solid #dddddd; - padding-left: 0.5em; -} - -/* IE6 sets dynamically generated links as visited. */ -div#toc a:visited { color: blue; } </style> <script type="text/javascript"> /*<+'])'); + var re = new RegExp('[hH]([1-'+(toclevels+1)+'])'); // Function that scans the DOM tree for header elements (the DOM2 // nodeIterator API would be a better technique but not supported by all // browsers). @@ -497,6 +597,25 @@ } var toc = document.getElementById("toc"); + if (!toc) { + return; + } + + // Delete existing TOC entries in case we're reloading the TOC. + var tocEntriesToRemove = []; + var i; + for (i = 0; i < toc.childNodes.length; i++) { + var entry = toc.childNodes[i]; + if (entry.nodeName.toLowerCase() == 'div' + && entry.getAttribute("class") + && entry.getAttribute("class").match(/^toclevel/)) + tocEntriesToRemove.push(entry); + } + for (i = 0; i < tocEntriesToRemove.length; i++) { + toc.removeChild(tocEntriesToRemove[i]); + } + + // Rebuild TOC entries. var entries = tocEntries(document.getElementById("content"), toclevels); for (var i = 0; i < entries.length; ++i) { var entry = entries[i]; @@ -524,24 +643,44 @@ */ footnotes: function () { - var cont = document.getElementById("content"); + // Delete existing footnote entries in case we're reloading the footnodes. + var i; var noteholder = document.getElementById("footnotes"); + if (!noteholder) { + return; + } + var entriesToRemove = []; + for (i = 0; i < noteholder.childNodes.length; i++) { + var entry = noteholder.childNodes[i]; + if (entry.nodeName.toLowerCase() == 'div' && entry.getAttribute("class") == "footnote") + entriesToRemove.push(entry); + } + for (i = 0; i < entriesToRemove.length; i++) { + noteholder.removeChild(entriesToRemove[i]); + } + + // Rebuild footnote entries. + var cont = document.getElementById("content"); var spans = cont.getElementsByTagName("span"); var refs = {}; var n = 0; for (i=0; i<spans.length; i++) { if (spans[i].className == "footnote") { n++; - // Use [\s\S] in place of . so multi-line matches work. - // Because JavaScript has no s (dotall) regex flag. - note = spans[i].innerHTML.match(/\s*\[([\s\S]*)]\s*/)[1]; + var note = spans[i].getAttribute("data-note"); + if (!note) { + // Use [\s\S] in place of . so multi-line matches work. + // Because JavaScript has no s (dotall) regex flag. + note = spans[i].innerHTML.match(/\s*\[([\s\S]*)]\s*/)[1]; + spans[i].innerHTML = + "[<a id='_footnoteref_" + n + "' href='#_footnote_" + n + + "' title='View footnote' class='footnote'>" + n + "</a>]"; + spans[i].setAttribute("data-note", note); + } noteholder.innerHTML += "<div class='footnote' id='_footnote_" + n + "'>" + "<a href='#_footnoteref_" + n + "' title='Return to text'>" + n + "</a>. " + note + "</div>"; - spans[i].innerHTML = - "[<a id='_footnoteref_" + n + "' href='#_footnote_" + n + - "' title='View footnote' class='footnote'>" + n + "</a>]"; var id =spans[i].getAttribute("id"); if (id != null) refs["#"+id] = n; } @@ -561,13 +700,36 @@ } } } +}, + +install: function(toclevels) { + var timerId; + + function reinstall() { + asciidoc.footnotes(); + if (toclevels) { + asciidoc.toc(toclevels); + } + } + + function reinstallAndRemoveTimer() { + clearInterval(timerId); + reinstall(); + } + + timerId = setInterval(reinstall, 500); + if (document.addEventListener) + document.addEventListener("DOMContentLoaded", reinstallAndRemoveTimer, false); + else + window.onload = reinstallAndRemoveTimer; } } +asciidoc.install(); /*]]>*/ </script> </head> -<body> +<body class="manpage"> <div id="header"> <h1> git-format-patch(1) Manual Page @@ -580,10 +742,11 @@ </div> </div> <div id="content"> +<div class="sect1"> <h2 id="_synopsis">SYNOPSIS</h2> <div class="sectionbody"> <div class="verseblock"> -<div class="verseblock-content"><em>git format-patch</em> [-k] [(-o|--output-directory) <dir> | --stdout] +<pre class="content"><em>git format-patch</em> [-k] [(-o|--output-directory) <dir> | --stdout] [--no-thread | --thread[=<style>]] [(--attach|--inline)[=<boundary>] | --no-attach] [-s | --signoff] @@ -596,10 +759,12 @@ [--to=<email>] [--cc=<email>] [--cover-letter] [--quiet] [--notes[=<ref>]] [<common diff options>] - [ <since> | <revision range> ]</div> -<div class="verseblock-attribution"> + [ <since> | <revision range> ]</pre> +<div class="attribution"> </div></div> </div> +</div> +<div class="sect1"> <h2 id="_description">DESCRIPTION</h2> <div class="sectionbody"> <div class="paragraph"><p>Prepare each commit with its patch in @@ -625,28 +790,30 @@ </ol></div> <div class="paragraph"><p>The first rule takes precedence in the case of a single <commit>. To apply the second rule, i.e., format everything since the beginning of -history up until <commit>, use the <em>--root</em> option: <tt>git format-patch ---root <commit></tt>. If you want to format only <commit> itself, you -can do this with <tt>git format-patch -1 <commit></tt>.</p></div> +history up until <commit>, use the <em>--root</em> option: <code>git format-patch +--root <commit></code>. If you want to format only <commit> itself, you +can do this with <code>git format-patch -1 <commit></code>.</p></div> <div class="paragraph"><p>By default, each output file is numbered sequentially from 1, and uses the first line of the commit message (massaged for pathname safety) as -the filename. With the <tt>--numbered-files</tt> option, the output file names +the filename. With the <code>--numbered-files</code> option, the output file names will only be numbers, without the first line of the commit appended. The names of the output files are printed to standard -output, unless the <tt>--stdout</tt> option is specified.</p></div> -<div class="paragraph"><p>If <tt>-o</tt> is specified, output files are created in <dir>. Otherwise +output, unless the <code>--stdout</code> option is specified.</p></div> +<div class="paragraph"><p>If <code>-o</code> is specified, output files are created in <dir>. Otherwise they are created in the current working directory.</p></div> <div class="paragraph"><p>By default, the subject of a single patch is "[PATCH] " followed by the concatenation of lines from the commit message up to the first blank line (see the DISCUSSION section of <a href="git-commit.html">git-commit(1)</a>).</p></div> <div class="paragraph"><p>When multiple patches are output, the subject prefix will instead be -"[PATCH n/m] ". To force 1/1 to be added for a single patch, use <tt>-n</tt>. -To omit patch numbers from the subject, use <tt>-N</tt>.</p></div> -<div class="paragraph"><p>If given <tt>--thread</tt>, <tt>git-format-patch</tt> will generate <tt>In-Reply-To</tt> and -<tt>References</tt> headers to make the second and subsequent patch mails appear -as replies to the first mail; this also generates a <tt>Message-Id</tt> header to +"[PATCH n/m] ". To force 1/1 to be added for a single patch, use <code>-n</code>. +To omit patch numbers from the subject, use <code>-N</code>.</p></div> +<div class="paragraph"><p>If given <code>--thread</code>, <code>git-format-patch</code> will generate <code>In-Reply-To</code> and +<code>References</code> headers to make the second and subsequent patch mails appear +as replies to the first mail; this also generates a <code>Message-Id</code> header to reference.</p></div> </div> +</div> +<div class="sect1"> <h2 id="_options">OPTIONS</h2> <div class="sectionbody"> <div class="dlist"><dl> @@ -707,29 +874,29 @@ will be used for the filename part, and the rest for the graph part. Maximum width defaults to terminal width, or 80 columns if not connected to a terminal, and can be overridden by - <tt><width></tt>. The width of the filename part can be limited by - giving another width <tt><name-width></tt> after a comma. The width + <code><width></code>. The width of the filename part can be limited by + giving another width <code><name-width></code> after a comma. The width of the graph part can be limited by using - <tt>--stat-graph-width=<width></tt> (affects all commands generating - a stat graph) or by setting <tt>diff.statGraphWidth=<width></tt> - (does not affect <tt>git format-patch</tt>). - By giving a third parameter <tt><count></tt>, you can limit the - output to the first <tt><count></tt> lines, followed by <tt>...</tt> if + <code>--stat-graph-width=<width></code> (affects all commands generating + a stat graph) or by setting <code>diff.statGraphWidth=<width></code> + (does not affect <code>git format-patch</code>). + By giving a third parameter <code><count></code>, you can limit the + output to the first <code><count></code> lines, followed by <code>...</code> if there are more. </p> -<div class="paragraph"><p>These parameters can also be set individually with <tt>--stat-width=<width></tt>, -<tt>--stat-name-width=<name-width></tt> and <tt>--stat-count=<count></tt>.</p></div> +<div class="paragraph"><p>These parameters can also be set individually with <code>--stat-width=<width></code>, +<code>--stat-name-width=<name-width></code> and <code>--stat-count=<count></code>.</p></div> </dd> <dt class="hdlist1"> --numstat </dt> <dd> <p> - Similar to <tt>--stat</tt>, but shows number of added and + Similar to <code>--stat</code>, but shows number of added and deleted lines in decimal notation and pathname without abbreviation, to make it more machine friendly. For - binary files, outputs two <tt>-</tt> instead of saying - <tt>0 0</tt>. + binary files, outputs two <code>-</code> instead of saying + <code>0 0</code>. </p> </dd> <dt class="hdlist1"> @@ -737,7 +904,7 @@ </dt> <dd> <p> - Output only the last line of the <tt>--stat</tt> format containing total + Output only the last line of the <code>--stat</code> format containing total number of modified files, as well as number of added and deleted lines. </p> @@ -748,15 +915,17 @@ <dd> <p> Output the distribution of relative amount of changes for each - sub-directory. The behavior of <tt>--dirstat</tt> can be customized by + sub-directory. The behavior of <code>--dirstat</code> can be customized by passing it a comma separated list of parameters. - The defaults are controlled by the <tt>diff.dirstat</tt> configuration + The defaults are controlled by the <code>diff.dirstat</code> configuration variable (see <a href="git-config.html">git-config(1)</a>). The following parameters are available: </p> +<div class="openblock"> +<div class="content"> <div class="dlist"><dl> <dt class="hdlist1"> -<tt>changes</tt> +<code>changes</code> </dt> <dd> <p> @@ -768,39 +937,39 @@ </p> </dd> <dt class="hdlist1"> -<tt>lines</tt> +<code>lines</code> </dt> <dd> <p> Compute the dirstat numbers by doing the regular line-based diff analysis, and summing the removed/added line counts. (For binary files, count 64-byte chunks instead, since binary files have no - natural concept of lines). This is a more expensive <tt>--dirstat</tt> - behavior than the <tt>changes</tt> behavior, but it does count rearranged + natural concept of lines). This is a more expensive <code>--dirstat</code> + behavior than the <code>changes</code> behavior, but it does count rearranged lines within a file as much as other changes. The resulting output - is consistent with what you get from the other <tt>--*stat</tt> options. + is consistent with what you get from the other <code>--*stat</code> options. </p> </dd> <dt class="hdlist1"> -<tt>files</tt> +<code>files</code> </dt> <dd> <p> Compute the dirstat numbers by counting the number of files changed. Each changed file counts equally in the dirstat analysis. This is - the computationally cheapest <tt>--dirstat</tt> behavior, since it does + the computationally cheapest <code>--dirstat</code> behavior, since it does not have to look at the file contents at all. </p> </dd> <dt class="hdlist1"> -<tt>cumulative</tt> +<code>cumulative</code> </dt> <dd> <p> Count changes in a child directory for the parent directory as well. - Note that when using <tt>cumulative</tt>, the sum of the percentages + Note that when using <code>cumulative</code>, the sum of the percentages reported may exceed 100%. The default (non-cumulative) behavior can - be specified with the <tt>noncumulative</tt> parameter. + be specified with the <code>noncumulative</code> parameter. </p> </dd> <dt class="hdlist1"> @@ -814,10 +983,11 @@ </p> </dd> </dl></div> +</div></div> <div class="paragraph"><p>Example: The following will count changed files, while ignoring directories with less than 10% of the total amount of changed files, and accumulating child directory counts in the parent directories: -<tt>--dirstat=files,10,cumulative</tt>.</p></div> +<code>--dirstat=files,10,cumulative</code>.</p></div> </dd> <dt class="hdlist1"> --summary @@ -852,8 +1022,8 @@ </dt> <dd> <p> - In addition to <tt>--full-index</tt>, output a binary diff that - can be applied with <tt>git-apply</tt>. + In addition to <code>--full-index</code>, output a binary diff that + can be applied with <code>git-apply</code>. </p> </dd> <dt class="hdlist1"> @@ -864,9 +1034,9 @@ Instead of showing the full 40-byte hexadecimal object name in diff-raw format output and diff-tree header lines, show only a partial prefix. This is - independent of the <tt>--full-index</tt> option above, which controls + independent of the <code>--full-index</code> option above, which controls the diff-patch output format. Non default number of - digits can be specified with <tt>--abbrev=<n></tt>. + digits can be specified with <code>--abbrev=<n></code>. </p> </dd> <dt class="hdlist1"> @@ -884,15 +1054,15 @@ not as a series of deletion and insertion mixed together with a very few lines that happen to match textually as the context, but as a single deletion of everything old followed by a single insertion of -everything new, and the number <tt>m</tt> controls this aspect of the -B -option (defaults to 60%). <tt>-B/70%</tt> specifies that less than 30% of the +everything new, and the number <code>m</code> controls this aspect of the -B +option (defaults to 60%). <code>-B/70%</code> specifies that less than 30% of the original should remain in the result for git to consider it a total rewrite (i.e. otherwise the resulting patch will be a series of deletion and insertion mixed together with context lines).</p></div> <div class="paragraph"><p>When used with -M, a totally-rewritten file is also considered as the source of a rename (usually -M only considers a file that disappeared -as the source of a rename), and the number <tt>n</tt> controls this aspect of -the -B option (defaults to 50%). <tt>-B20%</tt> specifies that a change with +as the source of a rename), and the number <code>n</code> controls this aspect of +the -B option (defaults to 50%). <code>-B20%</code> specifies that a change with addition and deletion compared to 20% or more of the file’s size are eligible for being picked up as a possible source of a rename to another file.</p></div> @@ -906,11 +1076,15 @@ <dd> <p> Detect renames. - If <tt>n</tt> is specified, it is a threshold on the similarity + If <code>n</code> is specified, it is a threshold on the similarity index (i.e. amount of addition/deletions compared to the - file’s size). For example, <tt>-M90%</tt> means git should consider a + file’s size). For example, <code>-M90%</code> means git should consider a delete/add pair to be a rename if more than 90% of the file - hasn’t changed. + hasn’t changed. Without a <code>%</code> sign, the number is to be read as + a fraction, with a decimal point before it. I.e., <code>-M5</code> becomes + 0.5, and is thus the same as <code>-M50%</code>. Similarly, <code>-M05</code> is + the same as <code>-M5%</code>. To limit detection to exact renames, use + <code>-M100%</code>. </p> </dd> <dt class="hdlist1"> @@ -921,8 +1095,8 @@ </dt> <dd> <p> - Detect copies as well as renames. See also <tt>--find-copies-harder</tt>. - If <tt>n</tt> is specified, it has the same meaning as for <tt>-M<n></tt>. + Detect copies as well as renames. See also <code>--find-copies-harder</code>. + If <code>n</code> is specified, it has the same meaning as for <code>-M<n></code>. </p> </dd> <dt class="hdlist1"> @@ -930,13 +1104,13 @@ </dt> <dd> <p> - For performance reasons, by default, <tt>-C</tt> option finds copies only + For performance reasons, by default, <code>-C</code> option finds copies only if the original file of the copy was modified in the same changeset. This flag makes the command inspect unmodified files as candidates for the source of copy. This is a very expensive operation for large projects, so use it with caution. Giving more than one - <tt>-C</tt> option has the same effect. + <code>-C</code> option has the same effect. </p> </dd> <dt class="hdlist1"> @@ -948,14 +1122,14 @@ <dd> <p> Omit the preimage for deletes, i.e. print only the header but not - the diff between the preimage and <tt>/dev/null</tt>. The resulting patch - is not meant to be applied with <tt>patch</tt> nor <tt>git apply</tt>; this is + the diff between the preimage and <code>/dev/null</code>. The resulting patch + is not meant to be applied with <code>patch</code> nor <code>git apply</code>; this is solely for people who want to just concentrate on reviewing the text after the change. In addition, the output obviously lack enough information to apply such a patch in reverse, even manually, hence the name of the option. </p> -<div class="paragraph"><p>When used together with <tt>-B</tt>, omit also the preimage in the deletion part +<div class="paragraph"><p>When used together with <code>-B</code>, omit also the preimage in the deletion part of a delete/create pair.</p></div> </dd> <dt class="hdlist1"> @@ -963,7 +1137,7 @@ </dt> <dd> <p> - The <tt>-M</tt> and <tt>-C</tt> options require O(n^2) processing time where n + The <code>-M</code> and <code>-C</code> options require O(n^2) processing time where n is the number of potential rename/copy targets. This option prevents rename/copy detection from running if the number of rename/copy targets exceeds the specified @@ -1205,7 +1379,7 @@ </dt> <dd> <p> - Add <tt>Signed-off-by:</tt> line to the commit message, using + Add <code>Signed-off-by:</code> line to the commit message, using the committer identity of yourself. </p> </dd> @@ -1225,7 +1399,7 @@ <p> Create multipart/mixed attachment, the first part of which is the commit message and the patch itself in the - second part, with <tt>Content-Disposition: attachment</tt>. + second part, with <code>Content-Disposition: attachment</code>. </p> </dd> <dt class="hdlist1"> @@ -1244,7 +1418,7 @@ <p> Create multipart/mixed attachment, the first part of which is the commit message and the patch itself in the - second part, with <tt>Content-Disposition: inline</tt>. + second part, with <code>Content-Disposition: inline</code>. </p> </dd> <dt class="hdlist1"> @@ -1255,29 +1429,29 @@ </dt> <dd> <p> - Controls addition of <tt>In-Reply-To</tt> and <tt>References</tt> headers to + Controls addition of <code>In-Reply-To</code> and <code>References</code> headers to make the second and subsequent mails appear as replies to the - first. Also controls generation of the <tt>Message-Id</tt> header to + first. Also controls generation of the <code>Message-Id</code> header to reference. </p> -<div class="paragraph"><p>The optional <style> argument can be either <tt>shallow</tt> or <tt>deep</tt>. +<div class="paragraph"><p>The optional <style> argument can be either <code>shallow</code> or <code>deep</code>. <em>shallow</em> threading makes every mail a reply to the head of the series, where the head is chosen from the cover letter, the -<tt>--in-reply-to</tt>, and the first patch mail, in this order. <em>deep</em> +<code>--in-reply-to</code>, and the first patch mail, in this order. <em>deep</em> threading makes every mail a reply to the previous one.</p></div> -<div class="paragraph"><p>The default is <tt>--no-thread</tt>, unless the <em>format.thread</em> configuration -is set. If <tt>--thread</tt> is specified without a style, it defaults to the -style specified by <em>format.thread</em> if any, or else <tt>shallow</tt>.</p></div> +<div class="paragraph"><p>The default is <code>--no-thread</code>, unless the <em>format.thread</em> configuration +is set. If <code>--thread</code> is specified without a style, it defaults to the +style specified by <em>format.thread</em> if any, or else <code>shallow</code>.</p></div> <div class="paragraph"><p>Beware that the default for <em>git send-email</em> is to thread emails -itself. If you want <tt>git format-patch</tt> to take care of threading, you -will want to ensure that threading is disabled for <tt>git send-email</tt>.</p></div> +itself. If you want <code>git format-patch</code> to take care of threading, you +will want to ensure that threading is disabled for <code>git send-email</code>.</p></div> </dd> <dt class="hdlist1"> --in-reply-to=Message-Id </dt> <dd> <p> - Make the first mail (or all the mails with <tt>--no-thread</tt>) appear as a + Make the first mail (or all the mails with <code>--no-thread</code>) appear as a reply to the given Message-Id, which avoids breaking threads to provide a new patch series. </p> @@ -1302,7 +1476,7 @@ Instead of the standard <em>[PATCH]</em> prefix in the subject line, instead use <em>[<Subject-Prefix>]</em>. This allows for useful naming of a patch series, and can be - combined with the <tt>--numbered</tt> option. + combined with the <code>--numbered</code> option. </p> </dd> <dt class="hdlist1"> @@ -1310,9 +1484,9 @@ </dt> <dd> <p> - Add a <tt>To:</tt> header to the email headers. This is in addition + Add a <code>To:</code> header to the email headers. This is in addition to any configured headers, and may be used multiple times. - The negated form <tt>--no-to</tt> discards all <tt>To:</tt> headers added so + The negated form <code>--no-to</code> discards all <code>To:</code> headers added so far (from config or command line). </p> </dd> @@ -1321,9 +1495,9 @@ </dt> <dd> <p> - Add a <tt>Cc:</tt> header to the email headers. This is in addition + Add a <code>Cc:</code> header to the email headers. This is in addition to any configured headers, and may be used multiple times. - The negated form <tt>--no-cc</tt> discards all <tt>Cc:</tt> headers added so + The negated form <code>--no-cc</code> discards all <code>Cc:</code> headers added so far (from config or command line). </p> </dd> @@ -1334,9 +1508,9 @@ <p> Add an arbitrary header to the email headers. This is in addition to any configured headers, and may be used multiple times. - For example, <tt>--add-header="Organization: git-foo"</tt>. - The negated form <tt>--no-add-header</tt> discards <strong>all</strong> (<tt>To:</tt>, - <tt>Cc:</tt>, and custom) headers added so far from config or command + For example, <code>--add-header="Organization: git-foo"</code>. + The negated form <code>--no-add-header</code> discards <strong>all</strong> (<code>To:</code>, + <code>Cc:</code>, and custom) headers added so far from config or command line. </p> </dd> @@ -1361,9 +1535,9 @@ <div class="paragraph"><p>The expected use case of this is to write supporting explanation for the commit that does not belong to the commit log message proper, and include it with the patch submission. While one can simply write -these explanations after <tt>format-patch</tt> has run but before sending, +these explanations after <code>format-patch</code> has run but before sending, keeping them as git notes allows them to be maintained between versions -of the patch series (but see the discussion of the <tt>notes.rewrite</tt> +of the patch series (but see the discussion of the <code>notes.rewrite</code> configuration options in <a href="git-notes.html">git-notes(1)</a> to use this workflow).</p></div> </dd> <dt class="hdlist1"> @@ -1382,13 +1556,13 @@ </dt> <dd> <p> - Instead of using <tt>.patch</tt> as the suffix for generated + Instead of using <code>.patch</code> as the suffix for generated filenames, use specified suffix. A common alternative is - <tt>--suffix=.txt</tt>. Leaving this empty will remove the <tt>.patch</tt> + <code>--suffix=.txt</code>. Leaving this empty will remove the <code>.patch</code> suffix. </p> <div class="paragraph"><p>Note that the leading character does not have to be a dot; for example, -you can use <tt>--suffix=-patch</tt> to get <tt>0001-description-of-my-change-patch</tt>.</p></div> +you can use <code>--suffix=-patch</code> to get <code>0001-description-of-my-change-patch</code>.</p></div> </dd> <dt class="hdlist1"> --quiet @@ -1423,6 +1597,8 @@ </dd> </dl></div> </div> +</div> +<div class="sect1"> <h2 id="_configuration">CONFIGURATION</h2> <div class="sectionbody"> <div class="paragraph"><p>You can specify extra mail header lines to be added to each message, @@ -1431,7 +1607,7 @@ attachments, and sign off patches with configuration variables.</p></div> <div class="listingblock"> <div class="content"> -<pre><tt>[format] +<pre><code>[format] headers = "Organization: git-foo\n" subjectprefix = CHANGE suffix = .txt @@ -1439,9 +1615,11 @@ to = <email> cc = <email> attach [ = mime-boundary-string ] - signoff = true</tt></pre> + signoff = true</code></pre> </div></div> </div> +</div> +<div class="sect1"> <h2 id="_discussion">DISCUSSION</h2> <div class="sectionbody"> <div class="paragraph"><p>The patch produced by <em>git format-patch</em> is in UNIX mailbox format, @@ -1449,7 +1627,7 @@ from format-patch rather than a real mailbox, like so:</p></div> <div class="listingblock"> <div class="content"> -<pre><tt>From 8f72bad1baf19a53459661343e21d6491c3908d3 Mon Sep 17 00:00:00 2001 +<pre><code>From 8f72bad1baf19a53459661343e21d6491c3908d3 Mon Sep 17 00:00:00 2001 From: Tony Luck <tony.luck@intel.com> Date: Tue, 13 Jul 2010 11:42:54 -0700 Subject: [PATCH] =?UTF-8?q?[IA64]=20Put=20ia64=20config=20files=20on=20the=20?= @@ -1462,7 +1640,7 @@ (See commit c2330e286f68f1c408b4aa6515ba49d57f05beae comment) Do the same for ia64 so we can have sleek & trim looking -...</tt></pre> +...</code></pre> </div></div> <div class="paragraph"><p>Typically it will be placed in a MUA’s drafts folder, edited to add timely commentary that should not go in the changelog after the three @@ -1473,11 +1651,11 @@ <div class="paragraph"><p>When a patch is part of an ongoing discussion, the patch generated by <em>git format-patch</em> can be tweaked to take advantage of the <em>git am --scissors</em> feature. After your response to the discussion comes a -line that consists solely of "<tt>-- >8 --</tt>" (scissors and perforation), +line that consists solely of "<code>-- >8 --</code>" (scissors and perforation), followed by the patch with unnecessary header fields removed:</p></div> <div class="listingblock"> <div class="content"> -<pre><tt>... +<pre><code>... > So we should do such-and-such. Makes sense to me. How about this patch? @@ -1486,15 +1664,16 @@ Subject: [IA64] Put ia64 config files on the Uwe Kleine-König diet arch/arm config files were slimmed down using a python script -...</tt></pre> +...</code></pre> </div></div> <div class="paragraph"><p>When sending a patch this way, most often you are sending your own -patch, so in addition to the "<tt>From $SHA1 $magic_timestamp</tt>" marker you -should omit <tt>From:</tt> and <tt>Date:</tt> lines from the patch file. The patch +patch, so in addition to the "<code>From $SHA1 $magic_timestamp</code>" marker you +should omit <code>From:</code> and <code>Date:</code> lines from the patch file. The patch title is likely to be different from the subject of the discussion the patch is in response to, so it is likely that you would want to keep the Subject: line, like the example above.</p></div> -<h3 id="_checking_for_patch_corruption">Checking for patch corruption</h3><div style="clear:left"></div> +<div class="sect2"> +<h3 id="_checking_for_patch_corruption">Checking for patch corruption</h3> <div class="paragraph"><p>Many mailers if not set up properly will corrupt whitespace. Here are two common types of corruption:</p></div> <div class="ulist"><ul> @@ -1531,10 +1710,10 @@ </p> <div class="literalblock"> <div class="content"> -<pre><tt>$ git fetch <project> master:test-apply +<pre><code>$ git fetch <project> master:test-apply $ git checkout test-apply $ git reset --hard -$ git am a.patch</tt></pre> +$ git am a.patch</code></pre> </div></div> </li> </ul></div> @@ -1569,11 +1748,15 @@ </li> </ul></div> </div> +</div> +</div> +<div class="sect1"> <h2 id="_mua_specific_hints">MUA-SPECIFIC HINTS</h2> <div class="sectionbody"> <div class="paragraph"><p>Here are some hints on how to successfully submit patches inline using various mailers.</p></div> -<h3 id="_gmail">GMail</h3><div style="clear:left"></div> +<div class="sect2"> +<h3 id="_gmail">GMail</h3> <div class="paragraph"><p>GMail does not have any way to turn off line wrapping in the web interface, so it will mangle any emails that you send. You can however use "git send-email" and send your patches through the GMail SMTP server, or @@ -1583,13 +1766,16 @@ GMail SMTP server, see the EXAMPLE section of <a href="git-send-email.html">git-send-email(1)</a>.</p></div> <div class="paragraph"><p>For hints on submission using the IMAP interface, see the EXAMPLE section of <a href="git-imap-send.html">git-imap-send(1)</a>.</p></div> -<h3 id="_thunderbird">Thunderbird</h3><div style="clear:left"></div> +</div> +<div class="sect2"> +<h3 id="_thunderbird">Thunderbird</h3> <div class="paragraph"><p>By default, Thunderbird will both wrap emails as well as flag them as being <em>format=flowed</em>, both of which will make the resulting email unusable by git.</p></div> <div class="paragraph"><p>There are three different approaches: use an add-on to turn off line wraps, configure Thunderbird to not mangle patches, or use an external editor to keep Thunderbird from mangling the patches.</p></div> +<div class="sect3"> <h4 id="_approach_1_add_on">Approach #1 (add-on)</h4> <div class="paragraph"><p>Install the Toggle Word Wrap add-on that is available from <a href="https://addons.mozilla.org/thunderbird/addon/toggle-word-wrap/">https://addons.mozilla.org/thunderbird/addon/toggle-word-wrap/</a> @@ -1597,6 +1783,8 @@ that you can tick off. Now you can compose the message as you otherwise do (cut + paste, <em>git format-patch</em> | <em>git imap-send</em>, etc), but you have to insert line breaks manually in any text that you type.</p></div> +</div> +<div class="sect3"> <h4 id="_approach_2_configuration">Approach #2 (configuration)</h4> <div class="paragraph"><p>Three steps:</p></div> <div class="olist arabic"><ol class="arabic"> @@ -1616,20 +1804,22 @@ <div class="paragraph"><p>In Thunderbird 3: Edit..Preferences..Advanced..Config Editor. Search for "mail.wrap_long_lines". -Toggle it to make sure it is set to <tt>false</tt>.</p></div> +Toggle it to make sure it is set to <code>false</code>.</p></div> </li> <li> <p> Disable the use of format=flowed: Edit..Preferences..Advanced..Config Editor. Search for "mailnews.send_plaintext_flowed". -Toggle it to make sure it is set to <tt>false</tt>. +Toggle it to make sure it is set to <code>false</code>. </p> </li> </ol></div> <div class="paragraph"><p>After that is done, you should be able to compose email as you otherwise would (cut + paste, <em>git format-patch</em> | <em>git imap-send</em>, etc), and the patches will not be mangled.</p></div> +</div> +<div class="sect3"> <h4 id="_approach_3_external_editor">Approach #3 (external editor)</h4> <div class="paragraph"><p>The following Thunderbird extensions are needed: AboutConfig from <a href="http://aboutconfig.mozdev.org/">http://aboutconfig.mozdev.org/</a> and @@ -1656,8 +1846,8 @@ </p> <div class="listingblock"> <div class="content"> -<pre><tt> mailnews.send_plaintext_flowed => false - mailnews.wraplength => 0</tt></pre> +<pre><code> mailnews.send_plaintext_flowed => false + mailnews.wraplength => 0</code></pre> </div></div> </li> <li> @@ -1676,14 +1866,17 @@ about:config and the following settings but no one’s tried yet.</p></div> <div class="listingblock"> <div class="content"> -<pre><tt> mail.html_compose => false +<pre><code> mail.html_compose => false mail.identity.default.compose_html => false - mail.identity.id?.compose_html => false</tt></pre> + mail.identity.id?.compose_html => false</code></pre> </div></div> <div class="paragraph"><p>There is a script in contrib/thunderbird-patch-inline which can help you include patches with Thunderbird in an easy way. To use it, do the steps above and then use the script as the external editor.</p></div> -<h3 id="_kmail">KMail</h3><div style="clear:left"></div> +</div> +</div> +<div class="sect2"> +<h3 id="_kmail">KMail</h3> <div class="paragraph"><p>This should help you to submit patches inline using KMail.</p></div> <div class="olist arabic"><ol class="arabic"> <li> @@ -1715,6 +1908,9 @@ </li> </ol></div> </div> +</div> +</div> +<div class="sect1"> <h2 id="_examples">EXAMPLES</h2> <div class="sectionbody"> <div class="ulist"><ul> @@ -1725,7 +1921,7 @@ </p> <div class="listingblock"> <div class="content"> -<pre><tt>$ git format-patch -k --stdout R1..R2 | git am -3 -k</tt></pre> +<pre><code>$ git format-patch -k --stdout R1..R2 | git am -3 -k</code></pre> </div></div> </li> <li> @@ -1735,7 +1931,7 @@ </p> <div class="listingblock"> <div class="content"> -<pre><tt>$ git format-patch origin</tt></pre> +<pre><code>$ git format-patch origin</code></pre> </div></div> <div class="paragraph"><p>For each commit a separate file is created in the current directory.</p></div> </li> @@ -1746,7 +1942,7 @@ </p> <div class="listingblock"> <div class="content"> -<pre><tt>$ git format-patch --root origin</tt></pre> +<pre><code>$ git format-patch --root origin</code></pre> </div></div> </li> <li> @@ -1755,7 +1951,7 @@ </p> <div class="listingblock"> <div class="content"> -<pre><tt>$ git format-patch -M -B origin</tt></pre> +<pre><code>$ git format-patch -M -B origin</code></pre> </div></div> <div class="paragraph"><p>Additionally, it detects and handles renames and complete rewrites intelligently to produce a renaming patch. A renaming patch reduces @@ -1770,24 +1966,29 @@ </p> <div class="listingblock"> <div class="content"> -<pre><tt>$ git format-patch -3</tt></pre> +<pre><code>$ git format-patch -3</code></pre> </div></div> </li> </ul></div> </div> +</div> +<div class="sect1"> <h2 id="_see_also">SEE ALSO</h2> <div class="sectionbody"> <div class="paragraph"><p><a href="git-am.html">git-am(1)</a>, <a href="git-send-email.html">git-send-email(1)</a></p></div> </div> +</div> +<div class="sect1"> <h2 id="_git">GIT</h2> <div class="sectionbody"> <div class="paragraph"><p>Part of the <a href="git.html">git(1)</a> suite</p></div> </div> </div> +</div> <div id="footnotes"><hr /></div> <div id="footer"> <div id="footer-text"> -Last updated 2012-11-15 13:11:54 PDT +Last updated 2012-11-15 13:11:54 PST </div> </div> </body> 